Skip to main content

Mentions API

Base URL​

/api

All endpoints require authentication using Authorization: Bearer <token>.

Endpoints​

GET /mentions​

Retrieve a list of all mentions/targeted account contents.

Headers:

  • Authorization: Bearer <token>

Query Parameters:

  • project_id (optional): Filter by project ID or keyword ID
  • sosmedId (optional): social media source (twitter, tiktok, facebook, youtube, or instagram)
  • sentimen (optional): 1, 0 or -1 (representation of positive(1), neutral(0), and negative(-1) )
  • limit (optional): Items per page (default: 10)
  • offset (optional): Pagination offset (default: 0)

Response:

{
  "data": [
    {
      "id": "mention_id",
      "targeted_account_id": "account_id",
      "content": "content",
      "keywordid": "project_id",
      "url": "source_url",
      "sentimen": 1,
      "socialmediaid": "socialmedia",
      "createdat": "2026-03-13T06:02:00Z",
      "updated_at": "0001-01-01T00:00:00Z",
      "targeted_account": {
        "username": "account_username",
        "display_name": "account_name"
      },
      "SnaKeyword": {
        "group": "project_name",
        "keyword": "\"keywords key\""
      }
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 10,
  "totalPages": 1
}

cURL

curl -X 'GET' \
  'https://beta-be.sociovite.com/api/mentions?keywordId={project_id}&page=1&limit=10&sentimen=1&sosmedId={socialmedia}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <token>'

Error Responses​

401 Unauthorized​

{
  "error": "Invalid or missing token"
}

403 Forbidden​

{
  "error": "Access denied"
}

500 Internal Server Error​

{
  "error": "Internal server error"
}

Response Fields Explanation​

Mention object​

  • id: Unique identifier for the mention
  • content: Text content of the mention
  • keyword_id: Related project ID
  • url: URL to the original content
  • sentimen: Sentiment analysis result for the content
  • socialmediaid: Social media platform (twitter, instagram, etc.)
  • createdat: Time the content was posted
  • updated_at: Time the content updated

Author object​

  • username: Username of the accout that posted the mention
  • display_name: Name of the account that posted the mention

Project object​

  • group: Related project name
  • keyword: Keyword that triggered the mention

Pagination object​

  • total: Total number of items
  • limit: Number of items per page
  • page: current page
  • totalPages: total of page